-
阐述
文档是与对象相关联的字符串元数据
-
添加
- 对象前面的一个字符串(双引号或三个双引号),以 Markdown 语言解析;它可以与定义在一起,也可以不在
- 用
@doc
宏将一个字符串(可以是任意字面量类型,如 raw)和对象联系起来,这种宏甚至可以处理用元编程生成的函数 - 因为这样的原因,当涉及到 LaTeX 时,总是用 raw
- 用
Docs.getdoc(t::T)
来处理某种类型的实例的文档 - 用
@__doc__
来在生成多个表达式的宏的内部添加文档
对于常见的函数和类型,存在一些固定的模板来添加文档,参见 Julia 函数文档模板和 Julia 类型文档模板。
-
提取
-
在 REPL 中用
?x
-
用
@doc
宏或doc()
函数 -
用 Documenter.jl 生成网页
-
格式
-
数学
-
行内公式:用两个反引号包括
-
行间公式:用代码块的语法,语言是 math
-
实例
-
性质
-
相关内容
-
参考文献